<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>webdoc</title>
    <link rel="stylesheet" type="text/css" href="../static/css/main.css">
</head>
<body>
<div class="nav">
    <div class="logo">
        
            webdoc
        
    </div>
<ul><li><a href="../index.html">0.Async</a></li><li><a href="../html/0.editor.html">0.editor</a></li><li><a href="../html/0.module.html">0.module</a></li><li><a href="../html/1.ES2015.html">1.ES2015</a></li><li><a href="../html/2.Promise.html">2.Promise</a></li><li><a href="../html/3.Node.html">3.Node</a></li><li><a href="../html/4.NodeInstall.html">4.NodeInstall</a></li><li><a href="../html/5.REPL.html">5.REPL</a></li><li><a href="../html/6.NodeCore.html">6.NodeCore</a></li><li><a href="../html/7.module&NPM.html">7.module&NPM</a></li><li><a href="../html/8.Encoding.html">8.Encoding</a></li><li><a href="../html/9.Buffer.html">9.Buffer</a></li><li><a href="../html/10.fs.html">10.fs</a></li><li><a href="../html/11.Stream-1.html">11.Stream-1</a></li><li><a href="../html/11.Stream-2.html">11.Stream-2</a></li><li><a href="../html/11.Stream-3.html">11.Stream-3</a></li><li><a href="../html/11.Stream-4.html">11.Stream-4</a></li><li><a href="../html/12-Network-2.html">12-Network-2</a></li><li><a href="../html/12.NetWork-3.html">12.NetWork-3</a></li><li><a href="../html/12.Network-1.html">12.Network-1</a></li><li><a href="../html/13.tcp.html">13.tcp</a></li><li><a href="../html/14.http-1.html">14.http-1</a></li><li><a href="../html/14.http-2.html">14.http-2</a></li><li><a href="../html/15.compress.html">15.compress</a></li><li><a href="../html/16.crypto.html">16.crypto</a></li><li><a href="../html/17.process.html">17.process</a></li><li><a href="../html/18.yargs.html">18.yargs</a></li><li><a href="../html/19.cache.html">19.cache</a></li><li><a href="../html/20.action.html">20.action</a></li><li><a href="../html/21.https.html">21.https</a></li><li><a href="../html/22.cookie.html">22.cookie</a></li><li><a href="../html/23.session.html">23.session</a></li><li><a href="../html/24.express-1.html">24.express-1</a></li><li><a href="../html/24.express-2.html">24.express-2</a></li><li><a href="../html/24.express-3.html">24.express-3</a></li><li><a href="../html/24.express-4.html">24.express-4</a></li><li><a href="../html/25.koa-1.html">25.koa-1</a></li><li><a href="../html/26.webpack-1-basic.html">26.webpack-1-basic</a></li><li><a href="../html/26.webpack-2-optimize.html">26.webpack-2-optimize</a></li><li><a href="../html/26.webpack-3.tapable.html">26.webpack-3.tapable</a></li><li><a href="../html/26.webpack-4-AST.html">26.webpack-4-AST</a></li><li><a href="../html/26.webpack-5-source.html">26.webpack-5-source</a></li><li><a href="../html/26.webpack-6-loader.html">26.webpack-6-loader</a></li><li><a href="../html/26.webpack-7-plugin.html">26.webpack-7-plugin</a></li><li><a href="../html/26.webpack-8-hand.html">26.webpack-8-hand</a></li><li><a href="../html/27.react-1.html">27.react-1</a></li><li><a href="../html/27.react-2.html">27.react-2</a></li><li><a href="../html/27.react-3.html">27.react-3</a></li><li><a href="../html/27.react-4-immutable.html">27.react-4-immutable</a></li><li><a href="../html/27.react-5-react-dom-diff.html">27.react-5-react-dom-diff</a></li><li><a href="../html/27.react-6.html">27.react-6</a></li><li><a href="../html/28.react-mobx.html">28.react-mobx</a></li><li><a href="../html/28.redux-0.html">28.redux-0</a></li><li><a href="../html/28.redux-1.html">28.redux-1</a></li><li><a href="../html/28.redux-2-中间件.html">28.redux-2-中间件</a></li><li><a href="../html/28.redux-3-saga.html">28.redux-3-saga</a></li><li><a href="../html/28.redux-jwt-back.html">28.redux-jwt-back</a></li><li><a href="../html/28.redux-jwt-front.html">28.redux-jwt-front</a></li><li><a href="../html/29.mongodb-1.html">29.mongodb-1</a></li><li><a href="../html/29.mongodb-2.html">29.mongodb-2</a></li><li><a href="../html/29.mongodb-3.html">29.mongodb-3</a></li><li><a href="../html/29.mongodb-4.html">29.mongodb-4</a></li><li><a href="../html/29.mongodb-5.html">29.mongodb-5</a></li><li><a href="../html/29.mongodb-6.html">29.mongodb-6</a></li><li><a href="../html/30.cms-1-mysql.html">30.cms-1-mysql</a></li><li><a href="../html/30.cms-2-mysql.html">30.cms-2-mysql</a></li><li><a href="../html/30.cms-3-mysql.html">30.cms-3-mysql</a></li><li><a href="../html/30.cms-4-egg.html">30.cms-4-egg</a></li><li><a href="../html/30.cms-5-api.html">30.cms-5-api</a></li><li><a href="../html/30.cms-6-roadhog.html">30.cms-6-roadhog</a></li><li><a href="../html/30.cms-7-umi.html">30.cms-7-umi</a></li><li><a href="../html/30.cms-8-dva.html">30.cms-8-dva</a></li><li><a href="../html/30.cms-9-dva.html">30.cms-9-dva</a></li><li><a href="../html/30.cms-10-dva.html">30.cms-10-dva</a></li><li><a href="../html/30.cms-11-front.html">30.cms-11-front</a></li><li><a href="../html/31.cms-12-api.html">31.cms-12-api</a></li><li><a href="../html/31.cms-13-front.html">31.cms-13-front</a></li><li><a href="../html/31.cms-14-deploy.html">31.cms-14-deploy</a></li><li><a href="../html/32.ant.html">32.ant</a></li><li><a href="../html/33.redis.html">33.redis</a></li><li><a href="../html/34.unittest.html">34.unittest</a></li><li><a href="../html/35.jwt.html">35.jwt</a></li><li><a href="../html/36.websocket-1.html">36.websocket-1</a></li><li><a href="../html/36.websocket-2.html">36.websocket-2</a></li><li class="active"><a href="../html/38.chat-api-1.html">38.chat-api-1</a></li><li><a href="../html/38.chat-api-2.html">38.chat-api-2</a></li><li><a href="../html/38.chat-3.html">38.chat-3</a></li><li><a href="../html/38.chat-api-3.html">38.chat-api-3</a></li><li><a href="../html/38.chat.html">38.chat</a></li><li><a href="../html/38.chat2.html">38.chat2</a></li><li><a href="../html/38.chat2.html">38.chat2</a></li><li><a href="../html/39.crawl-0.html">39.crawl-0</a></li><li><a href="../html/39.crawl-1.html">39.crawl-1</a></li><li><a href="../html/39.crawl-2.html">39.crawl-2</a></li><li><a href="../html/40.deploy.html">40.deploy</a></li><li><a href="../html/41.safe.html">41.safe</a></li><li><a href="../html/42.test.html">42.test</a></li><li><a href="../html/43.nginx.html">43.nginx</a></li><li><a href="../html/44.enzyme.html">44.enzyme</a></li><li><a href="../html/45.docker.html">45.docker</a></li><li><a href="../html/46.elastic.html">46.elastic</a></li><li><a href="../html/47.oauth.html">47.oauth</a></li><li><a href="../html/48.wxpay.html">48.wxpay</a></li><li><a href="../html/49.nunjucks.html">49.nunjucks</a></li><li><a href="../html/50.ketang.html">50.ketang</a></li><li><a href="../html/index.html">index</a></li><li><a href="../html/51.typescript.html">51.typescript</a></li><li><a href="../html/52.UML.html">52.UML</a></li><li><a href="../html/53.design.html">53.design</a></li><li><a href="../html/index.html">index</a></li></ul></div>


<div class="warpper">

    <div class="page-toc">
        <ul><li><a href="#t01. 珠峰聊天室接口文档">1. 珠峰聊天室接口文档</a></li><li><a href="#t12.用户">2.用户</a><ul><li><a href="#t22.1 登录">2.1 登录</a><ul><li><a href="#t32.1.1 请求路径">2.1.1 请求路径</a></li><li><a href="#t42.1.2 请求方法">2.1.2 请求方法</a></li><li><a href="#t52.1.3 请求参数">2.1.3 请求参数</a></li></ul></li><li><a href="#t62.2 验证用户身份">2.2 验证用户身份</a><ul><li><a href="#t72.2.1 请求路径">2.2.1 请求路径</a></li><li><a href="#t82.2.2 请求方法">2.2.2 请求方法</a></li><li><a href="#t92.2.3 请求参数">2.2.3 请求参数</a></li></ul></li></ul></li><li><a href="#t103.房间">3.房间</a><ul><li><a href="#t113.1 房间">3.1 房间</a><ul><li><a href="#t123.1.1 请求路径">3.1.1 请求路径</a></li><li><a href="#t133.1.2 请求方法">3.1.2 请求方法</a></li><li><a href="#t143.1.3 请求参数">3.1.3 请求参数</a></li></ul></li><li><a href="#t153.2 获取所有的房间">3.2 获取所有的房间</a><ul><li><a href="#t163.2.1 请求路径">3.2.1 请求路径</a></li><li><a href="#t173.2.2 请求方法">3.2.2 请求方法</a></li><li><a href="#t183.2.3 请求参数">3.2.3 请求参数</a></li></ul></li></ul></li><li><a href="#t194. 消息">4. 消息</a><ul><li><a href="#t204.1 添加消息">4.1 添加消息</a><ul><li><a href="#t214.1.1 消息类型">4.1.1 消息类型</a></li><li><a href="#t224.1.2 请求方法">4.1.2 请求方法</a></li><li><a href="#t234.1.3 请求参数">4.1.3 请求参数</a></li></ul></li><li><a href="#t244.2 查看所有的消息列表">4.2 查看所有的消息列表</a><ul><li><a href="#t254.2.1 消息类型">4.2.1 消息类型</a></li><li><a href="#t264.2.2 请求方法">4.2.2 请求方法</a></li><li><a href="#t274.2.3 请求参数">4.2.3 请求参数</a></li></ul></li></ul></li></ul>
    </div>
    
    <div class="content markdown-body">
        <h2 id="t01. &#x73E0;&#x5CF0;&#x804A;&#x5929;&#x5BA4;&#x63A5;&#x53E3;&#x6587;&#x6863;">1. &#x73E0;&#x5CF0;&#x804A;&#x5929;&#x5BA4;&#x63A5;&#x53E3;&#x6587;&#x6863; <a href="#t01. &#x73E0;&#x5CF0;&#x804A;&#x5929;&#x5BA4;&#x63A5;&#x53E3;&#x6587;&#x6863;"> # </a></h2>
<ul>
<li>&#x7528;&#x6237;<ul>
<li><a href="#/login">post /login &#x767B;&#x5F55;</a></li>
<li><a href="#/validate">post /validate &#x9A8C;&#x8BC1;&#x7528;&#x6237;&#x8EAB;&#x4EFD;</a></li>
</ul>
</li>
<li>&#x623F;&#x95F4;<ul>
<li><a href="&#x6DFB;&#x52A0;&#x623F;&#x95F4;">post /addRoom &#x6DFB;&#x52A0;&#x623F;&#x95F4;</a></li>
<li><a href="&#x67E5;&#x770B;&#x623F;&#x95F4;&#x5217;&#x8868;">get /getAllRooms &#x67E5;&#x770B;&#x623F;&#x95F4;&#x5217;&#x8868;</a></li>
</ul>
</li>
<li>&#x6D88;&#x606F;<ul>
<li><a href="&#x6DFB;&#x52A0;&#x6D88;&#x606F;">addMessage &#x6DFB;&#x52A0;&#x6D88;&#x606F;</a></li>
<li><a href="&#x83B7;&#x5F97;&#x6240;&#x6709;&#x6D88;&#x606F;">getAllMessages &#x83B7;&#x5F97;&#x6240;&#x6709;&#x6D88;&#x606F;</a></li>
</ul>
</li>
</ul>
<h2 id="t12.&#x7528;&#x6237;">2.&#x7528;&#x6237; <a href="#t12.&#x7528;&#x6237;"> # </a></h2>
<h3 id="t22.1 &#x767B;&#x5F55;">2.1 &#x767B;&#x5F55; <a href="#t22.1 &#x767B;&#x5F55;"> # </a></h3>
<h4 id="t32.1.1 &#x8BF7;&#x6C42;&#x8DEF;&#x5F84;">2.1.1 &#x8BF7;&#x6C42;&#x8DEF;&#x5F84; <a href="#t32.1.1 &#x8BF7;&#x6C42;&#x8DEF;&#x5F84;"> # </a></h4>
<p>/login</p>
<h4 id="t42.1.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5;">2.1.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5; <a href="#t42.1.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5;"> # </a></h4>
<p>POST</p>
<h4 id="t52.1.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570;">2.1.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570; <a href="#t52.1.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570;"> # </a></h4>
<p>&#x653E;&#x5728;&#x8BF7;&#x6C42;&#x4F53;&#x91CC;</p>
<pre><code class="lang-json">{
   <span class="hljs-attr">&quot;email&quot;</span>:<span class="hljs-string">&quot;zfpx@126.com&quot;</span>,
}
</code></pre>
<h3 id="t62.2 &#x9A8C;&#x8BC1;&#x7528;&#x6237;&#x8EAB;&#x4EFD;">2.2 &#x9A8C;&#x8BC1;&#x7528;&#x6237;&#x8EAB;&#x4EFD; <a href="#t62.2 &#x9A8C;&#x8BC1;&#x7528;&#x6237;&#x8EAB;&#x4EFD;"> # </a></h3>
<h4 id="t72.2.1 &#x8BF7;&#x6C42;&#x8DEF;&#x5F84;">2.2.1 &#x8BF7;&#x6C42;&#x8DEF;&#x5F84; <a href="#t72.2.1 &#x8BF7;&#x6C42;&#x8DEF;&#x5F84;"> # </a></h4>
<p>/validate</p>
<h4 id="t82.2.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5;">2.2.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5; <a href="#t82.2.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5;"> # </a></h4>
<p>POST</p>
<h4 id="t92.2.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570;">2.2.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570; <a href="#t92.2.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570;"> # </a></h4>
<p>&#x653E;&#x5728;&#x8BF7;&#x6C42;&#x4F53;&#x91CC;</p>
<pre><code class="lang-json">{
   <span class="hljs-attr">&quot;token&quot;</span>:<span class="hljs-string">&quot;xxxxxx&quot;</span>,
}
</code></pre>
<h2 id="t103.&#x623F;&#x95F4;">3.&#x623F;&#x95F4; <a href="#t103.&#x623F;&#x95F4;"> # </a></h2>
<h3 id="t113.1 &#x623F;&#x95F4;">3.1 &#x623F;&#x95F4; <a href="#t113.1 &#x623F;&#x95F4;"> # </a></h3>
<h4 id="t123.1.1 &#x8BF7;&#x6C42;&#x8DEF;&#x5F84;">3.1.1 &#x8BF7;&#x6C42;&#x8DEF;&#x5F84; <a href="#t123.1.1 &#x8BF7;&#x6C42;&#x8DEF;&#x5F84;"> # </a></h4>
<p>/addRoom</p>
<h4 id="t133.1.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5;">3.1.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5; <a href="#t133.1.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5;"> # </a></h4>
<p>POST</p>
<h4 id="t143.1.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570;">3.1.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570; <a href="#t143.1.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570;"> # </a></h4>
<p>&#x653E;&#x5728;&#x8BF7;&#x6C42;&#x4F53;&#x91CC;</p>
<pre><code class="lang-json">{
   <span class="hljs-attr">&quot;name&quot;</span>:<span class="hljs-string">&quot;&#x9752;&#x6DA9;&#x8BB0;&#x5FC6;&quot;</span>,
}
</code></pre>
<h3 id="t153.2 &#x83B7;&#x53D6;&#x6240;&#x6709;&#x7684;&#x623F;&#x95F4;">3.2 &#x83B7;&#x53D6;&#x6240;&#x6709;&#x7684;&#x623F;&#x95F4; <a href="#t153.2 &#x83B7;&#x53D6;&#x6240;&#x6709;&#x7684;&#x623F;&#x95F4;"> # </a></h3>
<h4 id="t163.2.1 &#x8BF7;&#x6C42;&#x8DEF;&#x5F84;">3.2.1 &#x8BF7;&#x6C42;&#x8DEF;&#x5F84; <a href="#t163.2.1 &#x8BF7;&#x6C42;&#x8DEF;&#x5F84;"> # </a></h4>
<p>/getAllRooms</p>
<h4 id="t173.2.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5;">3.2.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5; <a href="#t173.2.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5;"> # </a></h4>
<p>GET</p>
<h4 id="t183.2.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570;">3.2.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570; <a href="#t183.2.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570;"> # </a></h4>
<p>&#x65E0;</p>
<h2 id="t194. &#x6D88;&#x606F;">4. &#x6D88;&#x606F; <a href="#t194. &#x6D88;&#x606F;"> # </a></h2>
<h3 id="t204.1 &#x6DFB;&#x52A0;&#x6D88;&#x606F;">4.1 &#x6DFB;&#x52A0;&#x6D88;&#x606F; <a href="#t204.1 &#x6DFB;&#x52A0;&#x6D88;&#x606F;"> # </a></h3>
<h4 id="t214.1.1 &#x6D88;&#x606F;&#x7C7B;&#x578B;">4.1.1 &#x6D88;&#x606F;&#x7C7B;&#x578B; <a href="#t214.1.1 &#x6D88;&#x606F;&#x7C7B;&#x578B;"> # </a></h4>
<p>addMessage</p>
<h4 id="t224.1.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5;">4.1.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5; <a href="#t224.1.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5;"> # </a></h4>
<p>websocket</p>
<h4 id="t234.1.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570;">4.1.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570; <a href="#t234.1.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570;"> # </a></h4>
<pre><code class="lang-json">{
   <span class="hljs-attr">&quot;content&quot;</span>:<span class="hljs-string">&quot;&#x4F60;&#x597D;&quot;</span>,
   <span class="hljs-attr">&quot;user&quot;</span>:<span class="hljs-string">&quot;&quot;</span>,
   <span class="hljs-attr">&quot;room&quot;</span>:<span class="hljs-string">&quot;&quot;</span>
}
</code></pre>
<h3 id="t244.2 &#x67E5;&#x770B;&#x6240;&#x6709;&#x7684;&#x6D88;&#x606F;&#x5217;&#x8868;">4.2 &#x67E5;&#x770B;&#x6240;&#x6709;&#x7684;&#x6D88;&#x606F;&#x5217;&#x8868; <a href="#t244.2 &#x67E5;&#x770B;&#x6240;&#x6709;&#x7684;&#x6D88;&#x606F;&#x5217;&#x8868;"> # </a></h3>
<h4 id="t254.2.1 &#x6D88;&#x606F;&#x7C7B;&#x578B;">4.2.1 &#x6D88;&#x606F;&#x7C7B;&#x578B; <a href="#t254.2.1 &#x6D88;&#x606F;&#x7C7B;&#x578B;"> # </a></h4>
<p>getAllMessages</p>
<h4 id="t264.2.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5;">4.2.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5; <a href="#t264.2.2 &#x8BF7;&#x6C42;&#x65B9;&#x6CD5;"> # </a></h4>
<p>websocket</p>
<h4 id="t274.2.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570;">4.2.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570; <a href="#t274.2.3 &#x8BF7;&#x6C42;&#x53C2;&#x6570;"> # </a></h4>
<p>&#x65E0;</p>

        <div class="copyright">Powered by <a href="https://github.com/jaywcjlove/idoc" target="_blank">idoc</a>. Dependence <a href="https://nodejs.org">Node.js</a> run.</div>
    </div>
    
</div>

<script src="https://cdn.bootcss.com/jquery/3.0.0/jquery.js"></script>
<script>
$('.warpper .page-toc ul ul li a').on('click',function(){
  $('.warpper .page-toc ul ul li a').removeClass('my-active')
  $(this).addClass('my-active')
})
  // if (!$('.understand-me').length) {
  //   var bar = $(window).height() - $('.navbar ').height() - $('.page-toc').position().top;
  //   var count = bar / 26 / 2;
  //   var barHeight = $('.page-toc').outerHeight();
  //   $('.page-toc li').eq(0).children('a').addClass('red');
  //   var arr = [];
  //   $("h1,h2,h3,h4,h5,h6").each(function () {
  //     arr.push($(this).position().top);
  //   });
  //   var timer
  //   function dark() {
  //     clearTimeout(timer)
  //      timer = setTimeout(function () {
  //      var top = Math.abs($('.page-toc > ul').position().top);
  //      var cur = $('.content').scrollTop();
  //      for (var i = arr.length; i >= 0; i--) {
  //        if (arr[i] <= cur) {
  //          break;
  //        }
  //      }
  //      if (i === -1) {
  //        i = 0;
  //      }
  //      $('.page-toc li a').removeClass('red');
  //      $('.page-toc li').eq(i).children('a').addClass('red');
  //      let height = $('.page-toc li').eq(i).position().top-$('.page-toc').height(); // 如果当前的offset出去了 回到中间可好？
  //      $('.page-toc').scrollTop(height+$('.page-toc').height()/2);
  //    },200)
  //   }

  //   $('.content').on('scroll', dark);
  // }
</script>
<style>

    /* ::-webkit-scrollbar{width:14px;}
    ::-webkit-scrollbar-track{background-color:transparent;}
    ::-webkit-scrollbar-thumb{background-color:transparent;}
    ::-webkit-scrollbar-thumb:hover {background-color:transparent}
    ::-webkit-scrollbar-thumb:active {background-color:transparent} */

    .page-toc > ul .red {
        background: #f3f3f3;
        z-index: 1;
        border-left: 3px solid #009a61;
        -webkit-transition: all .2s ease;
        transition: all .2s ease;
        color: #000
    }





</style>
</body>
</html>
